home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2007 September / PCWSEP07.iso / Software / Linux / Linux Mint 3.0 Light / LinuxMint-3.0-Light.iso / casper / filesystem.squashfs / usr / lib / python2.5 / mailbox.pyc (.txt) < prev    next >
Encoding:
Python Compiled Bytecode  |  2007-05-11  |  69.0 KB  |  2,585 lines
  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. '''Read/write support for Maildir, mbox, MH, Babyl, and MMDF mailboxes.'''
  5. import sys
  6. import os
  7. import time
  8. import calendar
  9. import socket
  10. import errno
  11. import copy
  12. import email
  13. import email.Message as email
  14. import email.Generator as email
  15. import rfc822
  16. import StringIO
  17.  
  18. try:
  19.     if sys.platform == 'os2emx':
  20.         raise ImportError
  21.     
  22.     import fcntl
  23. except ImportError:
  24.     fcntl = None
  25.  
  26. __all__ = [
  27.     'Mailbox',
  28.     'Maildir',
  29.     'mbox',
  30.     'MH',
  31.     'Babyl',
  32.     'MMDF',
  33.     'Message',
  34.     'MaildirMessage',
  35.     'mboxMessage',
  36.     'MHMessage',
  37.     'BabylMessage',
  38.     'MMDFMessage',
  39.     'UnixMailbox',
  40.     'PortableUnixMailbox',
  41.     'MmdfMailbox',
  42.     'MHMailbox',
  43.     'BabylMailbox']
  44.  
  45. class Mailbox:
  46.     '''A group of messages in a particular place.'''
  47.     
  48.     def __init__(self, path, factory = None, create = True):
  49.         '''Initialize a Mailbox instance.'''
  50.         self._path = os.path.abspath(os.path.expanduser(path))
  51.         self._factory = factory
  52.  
  53.     
  54.     def add(self, message):
  55.         '''Add message and return assigned key.'''
  56.         raise NotImplementedError('Method must be implemented by subclass')
  57.  
  58.     
  59.     def remove(self, key):
  60.         """Remove the keyed message; raise KeyError if it doesn't exist."""
  61.         raise NotImplementedError('Method must be implemented by subclass')
  62.  
  63.     
  64.     def __delitem__(self, key):
  65.         self.remove(key)
  66.  
  67.     
  68.     def discard(self, key):
  69.         '''If the keyed message exists, remove it.'''
  70.         
  71.         try:
  72.             self.remove(key)
  73.         except KeyError:
  74.             pass
  75.  
  76.  
  77.     
  78.     def __setitem__(self, key, message):
  79.         """Replace the keyed message; raise KeyError if it doesn't exist."""
  80.         raise NotImplementedError('Method must be implemented by subclass')
  81.  
  82.     
  83.     def get(self, key, default = None):
  84.         """Return the keyed message, or default if it doesn't exist."""
  85.         
  86.         try:
  87.             return self.__getitem__(key)
  88.         except KeyError:
  89.             return default
  90.  
  91.  
  92.     
  93.     def __getitem__(self, key):
  94.         """Return the keyed message; raise KeyError if it doesn't exist."""
  95.         if not self._factory:
  96.             return self.get_message(key)
  97.         else:
  98.             return self._factory(self.get_file(key))
  99.  
  100.     
  101.     def get_message(self, key):
  102.         '''Return a Message representation or raise a KeyError.'''
  103.         raise NotImplementedError('Method must be implemented by subclass')
  104.  
  105.     
  106.     def get_string(self, key):
  107.         '''Return a string representation or raise a KeyError.'''
  108.         raise NotImplementedError('Method must be implemented by subclass')
  109.  
  110.     
  111.     def get_file(self, key):
  112.         '''Return a file-like representation or raise a KeyError.'''
  113.         raise NotImplementedError('Method must be implemented by subclass')
  114.  
  115.     
  116.     def iterkeys(self):
  117.         '''Return an iterator over keys.'''
  118.         raise NotImplementedError('Method must be implemented by subclass')
  119.  
  120.     
  121.     def keys(self):
  122.         '''Return a list of keys.'''
  123.         return list(self.iterkeys())
  124.  
  125.     
  126.     def itervalues(self):
  127.         '''Return an iterator over all messages.'''
  128.         for key in self.iterkeys():
  129.             
  130.             try:
  131.                 value = self[key]
  132.             except KeyError:
  133.                 continue
  134.  
  135.             yield value
  136.         
  137.  
  138.     
  139.     def __iter__(self):
  140.         return self.itervalues()
  141.  
  142.     
  143.     def values(self):
  144.         '''Return a list of messages. Memory intensive.'''
  145.         return list(self.itervalues())
  146.  
  147.     
  148.     def iteritems(self):
  149.         '''Return an iterator over (key, message) tuples.'''
  150.         for key in self.iterkeys():
  151.             
  152.             try:
  153.                 value = self[key]
  154.             except KeyError:
  155.                 continue
  156.  
  157.             yield (key, value)
  158.         
  159.  
  160.     
  161.     def items(self):
  162.         '''Return a list of (key, message) tuples. Memory intensive.'''
  163.         return list(self.iteritems())
  164.  
  165.     
  166.     def has_key(self, key):
  167.         '''Return True if the keyed message exists, False otherwise.'''
  168.         raise NotImplementedError('Method must be implemented by subclass')
  169.  
  170.     
  171.     def __contains__(self, key):
  172.         return self.has_key(key)
  173.  
  174.     
  175.     def __len__(self):
  176.         '''Return a count of messages in the mailbox.'''
  177.         raise NotImplementedError('Method must be implemented by subclass')
  178.  
  179.     
  180.     def clear(self):
  181.         '''Delete all messages.'''
  182.         for key in self.iterkeys():
  183.             self.discard(key)
  184.         
  185.  
  186.     
  187.     def pop(self, key, default = None):
  188.         '''Delete the keyed message and return it, or default.'''
  189.         
  190.         try:
  191.             result = self[key]
  192.         except KeyError:
  193.             return default
  194.  
  195.         self.discard(key)
  196.         return result
  197.  
  198.     
  199.     def popitem(self):
  200.         '''Delete an arbitrary (key, message) pair and return it.'''
  201.         for key in self.iterkeys():
  202.             return (key, self.pop(key))
  203.         else:
  204.             raise KeyError('No messages in mailbox')
  205.  
  206.     
  207.     def update(self, arg = None):
  208.         '''Change the messages that correspond to certain keys.'''
  209.         if hasattr(arg, 'iteritems'):
  210.             source = arg.iteritems()
  211.         elif hasattr(arg, 'items'):
  212.             source = arg.items()
  213.         else:
  214.             source = arg
  215.         bad_key = False
  216.         for key, message in source:
  217.             
  218.             try:
  219.                 self[key] = message
  220.             continue
  221.             except KeyError:
  222.                 bad_key = True
  223.                 continue
  224.             
  225.  
  226.         
  227.         if bad_key:
  228.             raise KeyError('No message with key(s)')
  229.         
  230.  
  231.     
  232.     def flush(self):
  233.         '''Write any pending changes to the disk.'''
  234.         raise NotImplementedError('Method must be implemented by subclass')
  235.  
  236.     
  237.     def lock(self):
  238.         '''Lock the mailbox.'''
  239.         raise NotImplementedError('Method must be implemented by subclass')
  240.  
  241.     
  242.     def unlock(self):
  243.         '''Unlock the mailbox if it is locked.'''
  244.         raise NotImplementedError('Method must be implemented by subclass')
  245.  
  246.     
  247.     def close(self):
  248.         '''Flush and close the mailbox.'''
  249.         raise NotImplementedError('Method must be implemented by subclass')
  250.  
  251.     
  252.     def _dump_message(self, message, target, mangle_from_ = False):
  253.         '''Dump message contents to target file.'''
  254.         if isinstance(message, email.Message.Message):
  255.             buffer = StringIO.StringIO()
  256.             gen = email.Generator.Generator(buffer, mangle_from_, 0)
  257.             gen.flatten(message)
  258.             buffer.seek(0)
  259.             target.write(buffer.read().replace('\n', os.linesep))
  260.         elif isinstance(message, str):
  261.             if mangle_from_:
  262.                 message = message.replace('\nFrom ', '\n>From ')
  263.             
  264.             message = message.replace('\n', os.linesep)
  265.             target.write(message)
  266.         elif hasattr(message, 'read'):
  267.             while True:
  268.                 line = message.readline()
  269.                 if line == '':
  270.                     break
  271.                 
  272.                 if mangle_from_ and line.startswith('From '):
  273.                     line = '>From ' + line[5:]
  274.                 
  275.                 line = line.replace('\n', os.linesep)
  276.                 target.write(line)
  277.         else:
  278.             raise TypeError('Invalid message type: %s' % type(message))
  279.  
  280.  
  281.  
  282. class Maildir(Mailbox):
  283.     '''A qmail-style Maildir mailbox.'''
  284.     colon = ':'
  285.     
  286.     def __init__(self, dirname, factory = rfc822.Message, create = True):
  287.         '''Initialize a Maildir instance.'''
  288.         Mailbox.__init__(self, dirname, factory, create)
  289.         if not os.path.exists(self._path):
  290.             if create:
  291.                 os.mkdir(self._path, 448)
  292.                 os.mkdir(os.path.join(self._path, 'tmp'), 448)
  293.                 os.mkdir(os.path.join(self._path, 'new'), 448)
  294.                 os.mkdir(os.path.join(self._path, 'cur'), 448)
  295.             else:
  296.                 raise NoSuchMailboxError(self._path)
  297.         
  298.         self._toc = { }
  299.  
  300.     
  301.     def add(self, message):
  302.         '''Add message and return assigned key.'''
  303.         tmp_file = self._create_tmp()
  304.         
  305.         try:
  306.             self._dump_message(message, tmp_file)
  307.         finally:
  308.             _sync_close(tmp_file)
  309.  
  310.         if isinstance(message, MaildirMessage):
  311.             subdir = message.get_subdir()
  312.             suffix = self.colon + message.get_info()
  313.             if suffix == self.colon:
  314.                 suffix = ''
  315.             
  316.         else:
  317.             subdir = 'new'
  318.             suffix = ''
  319.         uniq = os.path.basename(tmp_file.name).split(self.colon)[0]
  320.         dest = os.path.join(self._path, subdir, uniq + suffix)
  321.         
  322.         try:
  323.             if hasattr(os, 'link'):
  324.                 os.link(tmp_file.name, dest)
  325.                 os.remove(tmp_file.name)
  326.             else:
  327.                 os.rename(tmp_file.name, dest)
  328.         except OSError:
  329.             e = None
  330.             os.remove(tmp_file.name)
  331.             if e.errno == errno.EEXIST:
  332.                 raise ExternalClashError('Name clash with existing message: %s' % dest)
  333.             else:
  334.                 raise 
  335.         except:
  336.             e.errno == errno.EEXIST
  337.  
  338.         if isinstance(message, MaildirMessage):
  339.             os.utime(dest, (os.path.getatime(dest), message.get_date()))
  340.         
  341.         return uniq
  342.  
  343.     
  344.     def remove(self, key):
  345.         """Remove the keyed message; raise KeyError if it doesn't exist."""
  346.         os.remove(os.path.join(self._path, self._lookup(key)))
  347.  
  348.     
  349.     def discard(self, key):
  350.         '''If the keyed message exists, remove it.'''
  351.         
  352.         try:
  353.             self.remove(key)
  354.         except KeyError:
  355.             pass
  356.         except OSError:
  357.             e = None
  358.             if e.errno != errno.ENOENT:
  359.                 raise 
  360.             
  361.         except:
  362.             e.errno != errno.ENOENT
  363.  
  364.  
  365.     
  366.     def __setitem__(self, key, message):
  367.         """Replace the keyed message; raise KeyError if it doesn't exist."""
  368.         old_subpath = self._lookup(key)
  369.         temp_key = self.add(message)
  370.         temp_subpath = self._lookup(temp_key)
  371.         if isinstance(message, MaildirMessage):
  372.             dominant_subpath = temp_subpath
  373.         else:
  374.             dominant_subpath = old_subpath
  375.         subdir = os.path.dirname(dominant_subpath)
  376.         if self.colon in dominant_subpath:
  377.             suffix = self.colon + dominant_subpath.split(self.colon)[-1]
  378.         else:
  379.             suffix = ''
  380.         self.discard(key)
  381.         new_path = os.path.join(self._path, subdir, key + suffix)
  382.         os.rename(os.path.join(self._path, temp_subpath), new_path)
  383.         if isinstance(message, MaildirMessage):
  384.             os.utime(new_path, (os.path.getatime(new_path), message.get_date()))
  385.         
  386.  
  387.     
  388.     def get_message(self, key):
  389.         '''Return a Message representation or raise a KeyError.'''
  390.         subpath = self._lookup(key)
  391.         f = open(os.path.join(self._path, subpath), 'r')
  392.         
  393.         try:
  394.             msg = MaildirMessage(f)
  395.         finally:
  396.             f.close()
  397.  
  398.         (subdir, name) = os.path.split(subpath)
  399.         msg.set_subdir(subdir)
  400.         if self.colon in name:
  401.             msg.set_info(name.split(self.colon)[-1])
  402.         
  403.         msg.set_date(os.path.getmtime(os.path.join(self._path, subpath)))
  404.         return msg
  405.  
  406.     
  407.     def get_string(self, key):
  408.         '''Return a string representation or raise a KeyError.'''
  409.         f = open(os.path.join(self._path, self._lookup(key)), 'r')
  410.         
  411.         try:
  412.             return f.read()
  413.         finally:
  414.             f.close()
  415.  
  416.  
  417.     
  418.     def get_file(self, key):
  419.         '''Return a file-like representation or raise a KeyError.'''
  420.         f = open(os.path.join(self._path, self._lookup(key)), 'rb')
  421.         return _ProxyFile(f)
  422.  
  423.     
  424.     def iterkeys(self):
  425.         '''Return an iterator over keys.'''
  426.         self._refresh()
  427.         for key in self._toc:
  428.             
  429.             try:
  430.                 self._lookup(key)
  431.             except KeyError:
  432.                 continue
  433.  
  434.             yield key
  435.         
  436.  
  437.     
  438.     def has_key(self, key):
  439.         '''Return True if the keyed message exists, False otherwise.'''
  440.         self._refresh()
  441.         return key in self._toc
  442.  
  443.     
  444.     def __len__(self):
  445.         '''Return a count of messages in the mailbox.'''
  446.         self._refresh()
  447.         return len(self._toc)
  448.  
  449.     
  450.     def flush(self):
  451.         '''Write any pending changes to disk.'''
  452.         pass
  453.  
  454.     
  455.     def lock(self):
  456.         '''Lock the mailbox.'''
  457.         pass
  458.  
  459.     
  460.     def unlock(self):
  461.         '''Unlock the mailbox if it is locked.'''
  462.         pass
  463.  
  464.     
  465.     def close(self):
  466.         '''Flush and close the mailbox.'''
  467.         pass
  468.  
  469.     
  470.     def list_folders(self):
  471.         '''Return a list of folder names.'''
  472.         result = []
  473.         for entry in os.listdir(self._path):
  474.             if len(entry) > 1 and entry[0] == '.' and os.path.isdir(os.path.join(self._path, entry)):
  475.                 result.append(entry[1:])
  476.                 continue
  477.         
  478.         return result
  479.  
  480.     
  481.     def get_folder(self, folder):
  482.         '''Return a Maildir instance for the named folder.'''
  483.         return Maildir(os.path.join(self._path, '.' + folder), factory = self._factory, create = False)
  484.  
  485.     
  486.     def add_folder(self, folder):
  487.         '''Create a folder and return a Maildir instance representing it.'''
  488.         path = os.path.join(self._path, '.' + folder)
  489.         result = Maildir(path, factory = self._factory)
  490.         maildirfolder_path = os.path.join(path, 'maildirfolder')
  491.         if not os.path.exists(maildirfolder_path):
  492.             os.close(os.open(maildirfolder_path, os.O_CREAT | os.O_WRONLY))
  493.         
  494.         return result
  495.  
  496.     
  497.     def remove_folder(self, folder):
  498.         '''Delete the named folder, which must be empty.'''
  499.         path = os.path.join(self._path, '.' + folder)
  500.         for entry in os.listdir(os.path.join(path, 'new')) + os.listdir(os.path.join(path, 'cur')):
  501.             if len(entry) < 1 or entry[0] != '.':
  502.                 raise NotEmptyError('Folder contains message(s): %s' % folder)
  503.                 continue
  504.         
  505.         for entry in os.listdir(path):
  506.             if entry != 'new' and entry != 'cur' and entry != 'tmp' and os.path.isdir(os.path.join(path, entry)):
  507.                 raise NotEmptyError("Folder contains subdirectory '%s': %s" % (folder, entry))
  508.                 continue
  509.         
  510.         for root, dirs, files in os.walk(path, topdown = False):
  511.             for entry in files:
  512.                 os.remove(os.path.join(root, entry))
  513.             
  514.             for entry in dirs:
  515.                 os.rmdir(os.path.join(root, entry))
  516.             
  517.         
  518.         os.rmdir(path)
  519.  
  520.     
  521.     def clean(self):
  522.         '''Delete old files in "tmp".'''
  523.         now = time.time()
  524.         for entry in os.listdir(os.path.join(self._path, 'tmp')):
  525.             path = os.path.join(self._path, 'tmp', entry)
  526.             if now - os.path.getatime(path) > 129600:
  527.                 os.remove(path)
  528.                 continue
  529.         
  530.  
  531.     _count = 1
  532.     
  533.     def _create_tmp(self):
  534.         '''Create a file in the tmp subdirectory and open and return it.'''
  535.         now = time.time()
  536.         hostname = socket.gethostname()
  537.         if '/' in hostname:
  538.             hostname = hostname.replace('/', '\\057')
  539.         
  540.         if ':' in hostname:
  541.             hostname = hostname.replace(':', '\\072')
  542.         
  543.         uniq = '%s.M%sP%sQ%s.%s' % (int(now), int((now % 1) * 1e+06), os.getpid(), Maildir._count, hostname)
  544.         path = os.path.join(self._path, 'tmp', uniq)
  545.         
  546.         try:
  547.             os.stat(path)
  548.         except OSError:
  549.             e = None
  550.             if e.errno == errno.ENOENT:
  551.                 Maildir._count += 1
  552.                 
  553.                 try:
  554.                     return _create_carefully(path)
  555.                 except OSError:
  556.                     Maildir
  557.                     e = Maildir
  558.                     if e.errno != errno.EEXIST:
  559.                         raise 
  560.                     
  561.                 except:
  562.                     e.errno != errno.EEXIST
  563.                 
  564.  
  565.             Maildir<EXCEPTION MATCH>OSError
  566.             raise 
  567.         except:
  568.             Maildir
  569.  
  570.         raise ExternalClashError('Name clash prevented file creation: %s' % path)
  571.  
  572.     
  573.     def _refresh(self):
  574.         '''Update table of contents mapping.'''
  575.         self._toc = { }
  576.         for subdir in ('new', 'cur'):
  577.             for entry in os.listdir(os.path.join(self._path, subdir)):
  578.                 uniq = entry.split(self.colon)[0]
  579.                 self._toc[uniq] = os.path.join(subdir, entry)
  580.             
  581.         
  582.  
  583.     
  584.     def _lookup(self, key):
  585.         '''Use TOC to return subpath for given key, or raise a KeyError.'''
  586.         
  587.         try:
  588.             if os.path.exists(os.path.join(self._path, self._toc[key])):
  589.                 return self._toc[key]
  590.         except KeyError:
  591.             pass
  592.  
  593.         self._refresh()
  594.         
  595.         try:
  596.             return self._toc[key]
  597.         except KeyError:
  598.             raise KeyError('No message with key: %s' % key)
  599.  
  600.  
  601.     
  602.     def next(self):
  603.         '''Return the next message in a one-time iteration.'''
  604.         if not hasattr(self, '_onetime_keys'):
  605.             self._onetime_keys = self.iterkeys()
  606.         
  607.         while True:
  608.             
  609.             try:
  610.                 return self[self._onetime_keys.next()]
  611.             continue
  612.             except StopIteration:
  613.                 return None
  614.                 continue
  615.                 except KeyError:
  616.                     continue
  617.                     continue
  618.                 
  619.                 None<EXCEPTION MATCH>KeyError
  620.             return None
  621.  
  622.  
  623.  
  624.  
  625. class _singlefileMailbox(Mailbox):
  626.     '''A single-file mailbox.'''
  627.     
  628.     def __init__(self, path, factory = None, create = True):
  629.         '''Initialize a single-file mailbox.'''
  630.         Mailbox.__init__(self, path, factory, create)
  631.         
  632.         try:
  633.             f = open(self._path, 'rb+')
  634.         except IOError:
  635.             e = None
  636.             if e.errno == errno.ENOENT:
  637.                 if create:
  638.                     f = open(self._path, 'wb+')
  639.                 else:
  640.                     raise NoSuchMailboxError(self._path)
  641.             elif e.errno == errno.EACCES:
  642.                 f = open(self._path, 'rb')
  643.             else:
  644.                 raise 
  645.         except:
  646.             e.errno == errno.ENOENT
  647.  
  648.         self._file = f
  649.         self._toc = None
  650.         self._next_key = 0
  651.         self._pending = False
  652.         self._locked = False
  653.  
  654.     
  655.     def add(self, message):
  656.         '''Add message and return assigned key.'''
  657.         self._lookup()
  658.         self._toc[self._next_key] = self._append_message(message)
  659.         self._next_key += 1
  660.         self._pending = True
  661.         return self._next_key - 1
  662.  
  663.     
  664.     def remove(self, key):
  665.         """Remove the keyed message; raise KeyError if it doesn't exist."""
  666.         self._lookup(key)
  667.         del self._toc[key]
  668.         self._pending = True
  669.  
  670.     
  671.     def __setitem__(self, key, message):
  672.         """Replace the keyed message; raise KeyError if it doesn't exist."""
  673.         self._lookup(key)
  674.         self._toc[key] = self._append_message(message)
  675.         self._pending = True
  676.  
  677.     
  678.     def iterkeys(self):
  679.         '''Return an iterator over keys.'''
  680.         self._lookup()
  681.         for key in self._toc.keys():
  682.             yield key
  683.         
  684.  
  685.     
  686.     def has_key(self, key):
  687.         '''Return True if the keyed message exists, False otherwise.'''
  688.         self._lookup()
  689.         return key in self._toc
  690.  
  691.     
  692.     def __len__(self):
  693.         '''Return a count of messages in the mailbox.'''
  694.         self._lookup()
  695.         return len(self._toc)
  696.  
  697.     
  698.     def lock(self):
  699.         '''Lock the mailbox.'''
  700.         if not self._locked:
  701.             _lock_file(self._file)
  702.             self._locked = True
  703.         
  704.  
  705.     
  706.     def unlock(self):
  707.         '''Unlock the mailbox if it is locked.'''
  708.         if self._locked:
  709.             _unlock_file(self._file)
  710.             self._locked = False
  711.         
  712.  
  713.     
  714.     def flush(self):
  715.         '''Write any pending changes to disk.'''
  716.         if not self._pending:
  717.             return None
  718.         
  719.         self._lookup()
  720.         new_file = _create_temporary(self._path)
  721.         
  722.         try:
  723.             new_toc = { }
  724.             self._pre_mailbox_hook(new_file)
  725.             for key in sorted(self._toc.keys()):
  726.                 (start, stop) = self._toc[key]
  727.                 self._file.seek(start)
  728.                 self._pre_message_hook(new_file)
  729.                 new_start = new_file.tell()
  730.                 while True:
  731.                     buffer = self._file.read(min(4096, stop - self._file.tell()))
  732.                     if buffer == '':
  733.                         break
  734.                     
  735.                     new_file.write(buffer)
  736.                 new_toc[key] = (new_start, new_file.tell())
  737.                 self._post_message_hook(new_file)
  738.         except:
  739.             new_file.close()
  740.             os.remove(new_file.name)
  741.             raise 
  742.  
  743.         _sync_close(new_file)
  744.         self._file.close()
  745.         
  746.         try:
  747.             os.rename(new_file.name, self._path)
  748.         except OSError:
  749.             e = None
  750.             if (e.errno == errno.EEXIST or os.name == 'os2') and e.errno == errno.EACCES:
  751.                 os.remove(self._path)
  752.                 os.rename(new_file.name, self._path)
  753.             else:
  754.                 raise 
  755.         except:
  756.             e.errno == errno.EACCES
  757.  
  758.         self._file = open(self._path, 'rb+')
  759.         self._toc = new_toc
  760.         self._pending = False
  761.         if self._locked:
  762.             _lock_file(self._file, dotlock = False)
  763.         
  764.  
  765.     
  766.     def _pre_mailbox_hook(self, f):
  767.         '''Called before writing the mailbox to file f.'''
  768.         pass
  769.  
  770.     
  771.     def _pre_message_hook(self, f):
  772.         '''Called before writing each message to file f.'''
  773.         pass
  774.  
  775.     
  776.     def _post_message_hook(self, f):
  777.         '''Called after writing each message to file f.'''
  778.         pass
  779.  
  780.     
  781.     def close(self):
  782.         '''Flush and close the mailbox.'''
  783.         self.flush()
  784.         if self._locked:
  785.             self.unlock()
  786.         
  787.         self._file.close()
  788.  
  789.     
  790.     def _lookup(self, key = None):
  791.         '''Return (start, stop) or raise KeyError.'''
  792.         if self._toc is None:
  793.             self._generate_toc()
  794.         
  795.         if key is not None:
  796.             
  797.             try:
  798.                 return self._toc[key]
  799.             except KeyError:
  800.                 raise KeyError('No message with key: %s' % key)
  801.             except:
  802.                 None<EXCEPTION MATCH>KeyError
  803.             
  804.  
  805.         None<EXCEPTION MATCH>KeyError
  806.  
  807.     
  808.     def _append_message(self, message):
  809.         '''Append message to mailbox and return (start, stop) offsets.'''
  810.         self._file.seek(0, 2)
  811.         self._pre_message_hook(self._file)
  812.         offsets = self._install_message(message)
  813.         self._post_message_hook(self._file)
  814.         self._file.flush()
  815.         return offsets
  816.  
  817.  
  818.  
  819. class _mboxMMDF(_singlefileMailbox):
  820.     '''An mbox or MMDF mailbox.'''
  821.     _mangle_from_ = True
  822.     
  823.     def get_message(self, key):
  824.         '''Return a Message representation or raise a KeyError.'''
  825.         (start, stop) = self._lookup(key)
  826.         self._file.seek(start)
  827.         from_line = self._file.readline().replace(os.linesep, '')
  828.         string = self._file.read(stop - self._file.tell())
  829.         msg = self._message_factory(string.replace(os.linesep, '\n'))
  830.         msg.set_from(from_line[5:])
  831.         return msg
  832.  
  833.     
  834.     def get_string(self, key, from_ = False):
  835.         '''Return a string representation or raise a KeyError.'''
  836.         (start, stop) = self._lookup(key)
  837.         self._file.seek(start)
  838.         if not from_:
  839.             self._file.readline()
  840.         
  841.         string = self._file.read(stop - self._file.tell())
  842.         return string.replace(os.linesep, '\n')
  843.  
  844.     
  845.     def get_file(self, key, from_ = False):
  846.         '''Return a file-like representation or raise a KeyError.'''
  847.         (start, stop) = self._lookup(key)
  848.         self._file.seek(start)
  849.         if not from_:
  850.             self._file.readline()
  851.         
  852.         return _PartialFile(self._file, self._file.tell(), stop)
  853.  
  854.     
  855.     def _install_message(self, message):
  856.         '''Format a message and blindly write to self._file.'''
  857.         from_line = None
  858.         if isinstance(message, str) and message.startswith('From '):
  859.             newline = message.find('\n')
  860.             if newline != -1:
  861.                 from_line = message[:newline]
  862.                 message = message[newline + 1:]
  863.             else:
  864.                 from_line = message
  865.                 message = ''
  866.         elif isinstance(message, _mboxMMDFMessage):
  867.             from_line = 'From ' + message.get_from()
  868.         elif isinstance(message, email.Message.Message):
  869.             from_line = message.get_unixfrom()
  870.         
  871.         if from_line is None:
  872.             from_line = 'From MAILER-DAEMON %s' % time.asctime(time.gmtime())
  873.         
  874.         start = self._file.tell()
  875.         self._file.write(from_line + os.linesep)
  876.         self._dump_message(message, self._file, self._mangle_from_)
  877.         stop = self._file.tell()
  878.         return (start, stop)
  879.  
  880.  
  881.  
  882. class mbox(_mboxMMDF):
  883.     '''A classic mbox mailbox.'''
  884.     _mangle_from_ = True
  885.     
  886.     def __init__(self, path, factory = None, create = True):
  887.         '''Initialize an mbox mailbox.'''
  888.         self._message_factory = mboxMessage
  889.         _mboxMMDF.__init__(self, path, factory, create)
  890.  
  891.     
  892.     def _pre_message_hook(self, f):
  893.         '''Called before writing each message to file f.'''
  894.         if f.tell() != 0:
  895.             f.write(os.linesep)
  896.         
  897.  
  898.     
  899.     def _generate_toc(self):
  900.         '''Generate key-to-(start, stop) table of contents.'''
  901.         starts = []
  902.         stops = []
  903.         self._file.seek(0)
  904.         while True:
  905.             line_pos = self._file.tell()
  906.             line = self._file.readline()
  907.             if line.startswith('From '):
  908.                 if len(stops) < len(starts):
  909.                     stops.append(line_pos - len(os.linesep))
  910.                 
  911.                 starts.append(line_pos)
  912.                 continue
  913.             if line == '':
  914.                 stops.append(line_pos)
  915.                 break
  916.                 continue
  917.         self._toc = dict(enumerate(zip(starts, stops)))
  918.         self._next_key = len(self._toc)
  919.  
  920.  
  921.  
  922. class MMDF(_mboxMMDF):
  923.     '''An MMDF mailbox.'''
  924.     
  925.     def __init__(self, path, factory = None, create = True):
  926.         '''Initialize an MMDF mailbox.'''
  927.         self._message_factory = MMDFMessage
  928.         _mboxMMDF.__init__(self, path, factory, create)
  929.  
  930.     
  931.     def _pre_message_hook(self, f):
  932.         '''Called before writing each message to file f.'''
  933.         f.write('\x01\x01\x01\x01' + os.linesep)
  934.  
  935.     
  936.     def _post_message_hook(self, f):
  937.         '''Called after writing each message to file f.'''
  938.         f.write(os.linesep + '\x01\x01\x01\x01' + os.linesep)
  939.  
  940.     
  941.     def _generate_toc(self):
  942.         '''Generate key-to-(start, stop) table of contents.'''
  943.         starts = []
  944.         stops = []
  945.         self._file.seek(0)
  946.         next_pos = 0
  947.         while True:
  948.             line_pos = next_pos
  949.             line = self._file.readline()
  950.             next_pos = self._file.tell()
  951.             if line.startswith('\x01\x01\x01\x01' + os.linesep):
  952.                 starts.append(next_pos)
  953.                 while True:
  954.                     line_pos = next_pos
  955.                     line = self._file.readline()
  956.                     next_pos = self._file.tell()
  957.                     if line == '\x01\x01\x01\x01' + os.linesep:
  958.                         stops.append(line_pos - len(os.linesep))
  959.                         break
  960.                         continue
  961.                     if line == '':
  962.                         stops.append(line_pos)
  963.                         break
  964.                         continue
  965.                 continue
  966.             if line == '':
  967.                 break
  968.                 continue
  969.         self._toc = dict(enumerate(zip(starts, stops)))
  970.         self._next_key = len(self._toc)
  971.  
  972.  
  973.  
  974. class MH(Mailbox):
  975.     '''An MH mailbox.'''
  976.     
  977.     def __init__(self, path, factory = None, create = True):
  978.         '''Initialize an MH instance.'''
  979.         Mailbox.__init__(self, path, factory, create)
  980.         if not os.path.exists(self._path):
  981.             if create:
  982.                 os.mkdir(self._path, 448)
  983.                 os.close(os.open(os.path.join(self._path, '.mh_sequences'), os.O_CREAT | os.O_EXCL | os.O_WRONLY, 384))
  984.             else:
  985.                 raise NoSuchMailboxError(self._path)
  986.         
  987.         self._locked = False
  988.  
  989.     
  990.     def add(self, message):
  991.         '''Add message and return assigned key.'''
  992.         keys = self.keys()
  993.         if len(keys) == 0:
  994.             new_key = 1
  995.         else:
  996.             new_key = max(keys) + 1
  997.         new_path = os.path.join(self._path, str(new_key))
  998.         f = _create_carefully(new_path)
  999.         
  1000.         try:
  1001.             if self._locked:
  1002.                 _lock_file(f)
  1003.             
  1004.             
  1005.             try:
  1006.                 self._dump_message(message, f)
  1007.                 if isinstance(message, MHMessage):
  1008.                     self._dump_sequences(message, new_key)
  1009.             finally:
  1010.                 if self._locked:
  1011.                     _unlock_file(f)
  1012.                 
  1013.  
  1014.         finally:
  1015.             _sync_close(f)
  1016.  
  1017.         return new_key
  1018.  
  1019.     
  1020.     def remove(self, key):
  1021.         """Remove the keyed message; raise KeyError if it doesn't exist."""
  1022.         path = os.path.join(self._path, str(key))
  1023.         
  1024.         try:
  1025.             f = open(path, 'rb+')
  1026.         except IOError:
  1027.             e = None
  1028.             if e.errno == errno.ENOENT:
  1029.                 raise KeyError('No message with key: %s' % key)
  1030.             else:
  1031.                 raise 
  1032.         except:
  1033.             e.errno == errno.ENOENT
  1034.  
  1035.         
  1036.         try:
  1037.             if self._locked:
  1038.                 _lock_file(f)
  1039.             
  1040.             
  1041.             try:
  1042.                 f.close()
  1043.                 os.remove(os.path.join(self._path, str(key)))
  1044.             finally:
  1045.                 if self._locked:
  1046.                     _unlock_file(f)
  1047.                 
  1048.  
  1049.         finally:
  1050.             f.close()
  1051.  
  1052.  
  1053.     
  1054.     def __setitem__(self, key, message):
  1055.         """Replace the keyed message; raise KeyError if it doesn't exist."""
  1056.         path = os.path.join(self._path, str(key))
  1057.         
  1058.         try:
  1059.             f = open(path, 'rb+')
  1060.         except IOError:
  1061.             e = None
  1062.             if e.errno == errno.ENOENT:
  1063.                 raise KeyError('No message with key: %s' % key)
  1064.             else:
  1065.                 raise 
  1066.         except:
  1067.             e.errno == errno.ENOENT
  1068.  
  1069.         
  1070.         try:
  1071.             if self._locked:
  1072.                 _lock_file(f)
  1073.             
  1074.             
  1075.             try:
  1076.                 os.close(os.open(path, os.O_WRONLY | os.O_TRUNC))
  1077.                 self._dump_message(message, f)
  1078.                 if isinstance(message, MHMessage):
  1079.                     self._dump_sequences(message, key)
  1080.             finally:
  1081.                 if self._locked:
  1082.                     _unlock_file(f)
  1083.                 
  1084.  
  1085.         finally:
  1086.             _sync_close(f)
  1087.  
  1088.  
  1089.     
  1090.     def get_message(self, key):
  1091.         '''Return a Message representation or raise a KeyError.'''
  1092.         
  1093.         try:
  1094.             if self._locked:
  1095.                 f = open(os.path.join(self._path, str(key)), 'r+')
  1096.             else:
  1097.                 f = open(os.path.join(self._path, str(key)), 'r')
  1098.         except IOError:
  1099.             e = None
  1100.             if e.errno == errno.ENOENT:
  1101.                 raise KeyError('No message with key: %s' % key)
  1102.             else:
  1103.                 raise 
  1104.         except:
  1105.             e.errno == errno.ENOENT
  1106.  
  1107.         
  1108.         try:
  1109.             if self._locked:
  1110.                 _lock_file(f)
  1111.             
  1112.             
  1113.             try:
  1114.                 msg = MHMessage(f)
  1115.             finally:
  1116.                 if self._locked:
  1117.                     _unlock_file(f)
  1118.                 
  1119.  
  1120.         finally:
  1121.             f.close()
  1122.  
  1123.         for name, key_list in self.get_sequences():
  1124.             if key in key_list:
  1125.                 msg.add_sequence(name)
  1126.                 continue
  1127.         
  1128.         return msg
  1129.  
  1130.     
  1131.     def get_string(self, key):
  1132.         '''Return a string representation or raise a KeyError.'''
  1133.         
  1134.         try:
  1135.             if self._locked:
  1136.                 f = open(os.path.join(self._path, str(key)), 'r+')
  1137.             else:
  1138.                 f = open(os.path.join(self._path, str(key)), 'r')
  1139.         except IOError:
  1140.             e = None
  1141.             if e.errno == errno.ENOENT:
  1142.                 raise KeyError('No message with key: %s' % key)
  1143.             else:
  1144.                 raise 
  1145.         except:
  1146.             e.errno == errno.ENOENT
  1147.  
  1148.         
  1149.         try:
  1150.             if self._locked:
  1151.                 _lock_file(f)
  1152.             
  1153.             
  1154.             try:
  1155.                 return f.read()
  1156.             finally:
  1157.                 if self._locked:
  1158.                     _unlock_file(f)
  1159.                 
  1160.  
  1161.         finally:
  1162.             f.close()
  1163.  
  1164.  
  1165.     
  1166.     def get_file(self, key):
  1167.         '''Return a file-like representation or raise a KeyError.'''
  1168.         
  1169.         try:
  1170.             f = open(os.path.join(self._path, str(key)), 'rb')
  1171.         except IOError:
  1172.             e = None
  1173.             if e.errno == errno.ENOENT:
  1174.                 raise KeyError('No message with key: %s' % key)
  1175.             else:
  1176.                 raise 
  1177.         except:
  1178.             e.errno == errno.ENOENT
  1179.  
  1180.         return _ProxyFile(f)
  1181.  
  1182.     
  1183.     def iterkeys(self):
  1184.         '''Return an iterator over keys.'''
  1185.         return iter(sorted((lambda .0: for entry in .0:
  1186. if entry.isdigit():
  1187. int(entry)continue)(os.listdir(self._path))))
  1188.  
  1189.     
  1190.     def has_key(self, key):
  1191.         '''Return True if the keyed message exists, False otherwise.'''
  1192.         return os.path.exists(os.path.join(self._path, str(key)))
  1193.  
  1194.     
  1195.     def __len__(self):
  1196.         '''Return a count of messages in the mailbox.'''
  1197.         return len(list(self.iterkeys()))
  1198.  
  1199.     
  1200.     def lock(self):
  1201.         '''Lock the mailbox.'''
  1202.         if not self._locked:
  1203.             self._file = open(os.path.join(self._path, '.mh_sequences'), 'rb+')
  1204.             _lock_file(self._file)
  1205.             self._locked = True
  1206.         
  1207.  
  1208.     
  1209.     def unlock(self):
  1210.         '''Unlock the mailbox if it is locked.'''
  1211.         if self._locked:
  1212.             _unlock_file(self._file)
  1213.             _sync_close(self._file)
  1214.             del self._file
  1215.             self._locked = False
  1216.         
  1217.  
  1218.     
  1219.     def flush(self):
  1220.         '''Write any pending changes to the disk.'''
  1221.         pass
  1222.  
  1223.     
  1224.     def close(self):
  1225.         '''Flush and close the mailbox.'''
  1226.         if self._locked:
  1227.             self.unlock()
  1228.         
  1229.  
  1230.     
  1231.     def list_folders(self):
  1232.         '''Return a list of folder names.'''
  1233.         result = []
  1234.         for entry in os.listdir(self._path):
  1235.             if os.path.isdir(os.path.join(self._path, entry)):
  1236.                 result.append(entry)
  1237.                 continue
  1238.         
  1239.         return result
  1240.  
  1241.     
  1242.     def get_folder(self, folder):
  1243.         '''Return an MH instance for the named folder.'''
  1244.         return MH(os.path.join(self._path, folder), factory = self._factory, create = False)
  1245.  
  1246.     
  1247.     def add_folder(self, folder):
  1248.         '''Create a folder and return an MH instance representing it.'''
  1249.         return MH(os.path.join(self._path, folder), factory = self._factory)
  1250.  
  1251.     
  1252.     def remove_folder(self, folder):
  1253.         '''Delete the named folder, which must be empty.'''
  1254.         path = os.path.join(self._path, folder)
  1255.         entries = os.listdir(path)
  1256.         if entries == [
  1257.             '.mh_sequences']:
  1258.             os.remove(os.path.join(path, '.mh_sequences'))
  1259.         elif entries == []:
  1260.             pass
  1261.         else:
  1262.             raise NotEmptyError('Folder not empty: %s' % self._path)
  1263.         os.rmdir(path)
  1264.  
  1265.     
  1266.     def get_sequences(self):
  1267.         '''Return a name-to-key-list dictionary to define each sequence.'''
  1268.         results = { }
  1269.         f = open(os.path.join(self._path, '.mh_sequences'), 'r')
  1270.         
  1271.         try:
  1272.             all_keys = set(self.keys())
  1273.             for line in f:
  1274.                 
  1275.                 try:
  1276.                     (name, contents) = line.split(':')
  1277.                     keys = set()
  1278.                     for spec in contents.split():
  1279.                         if spec.isdigit():
  1280.                             keys.add(int(spec))
  1281.                             continue
  1282.                         (start, stop) = (lambda .0: for x in .0:
  1283. int(x))(spec.split('-'))
  1284.                         keys.update(range(start, stop + 1))
  1285.                     
  1286.                     results[name] = _[1]
  1287.                     if len(results[name]) == 0:
  1288.                         del results[name]
  1289.                 continue
  1290.                 except ValueError:
  1291.                     raise FormatError('Invalid sequence specification: %s' % line.rstrip())
  1292.                     continue
  1293.                 
  1294.  
  1295.         finally:
  1296.             f.close()
  1297.  
  1298.         return results
  1299.  
  1300.     
  1301.     def set_sequences(self, sequences):
  1302.         '''Set sequences using the given name-to-key-list dictionary.'''
  1303.         f = open(os.path.join(self._path, '.mh_sequences'), 'r+')
  1304.         
  1305.         try:
  1306.             os.close(os.open(f.name, os.O_WRONLY | os.O_TRUNC))
  1307.             for name, keys in sequences.iteritems():
  1308.                 if len(keys) == 0:
  1309.                     continue
  1310.                 
  1311.                 f.write('%s:' % name)
  1312.                 prev = None
  1313.                 completing = False
  1314.                 for key in sorted(set(keys)):
  1315.                     if key - 1 == prev:
  1316.                         if not completing:
  1317.                             completing = True
  1318.                             f.write('-')
  1319.                         
  1320.                     elif completing:
  1321.                         completing = False
  1322.                         f.write('%s %s' % (prev, key))
  1323.                     else:
  1324.                         f.write(' %s' % key)
  1325.                     prev = key
  1326.                 
  1327.                 if completing:
  1328.                     f.write(str(prev) + '\n')
  1329.                     continue
  1330.                 f.write('\n')
  1331.         finally:
  1332.             _sync_close(f)
  1333.  
  1334.  
  1335.     
  1336.     def pack(self):
  1337.         '''Re-name messages to eliminate numbering gaps. Invalidates keys.'''
  1338.         sequences = self.get_sequences()
  1339.         prev = 0
  1340.         changes = []
  1341.         for key in self.iterkeys():
  1342.             if key - 1 != prev:
  1343.                 changes.append((key, prev + 1))
  1344.                 if hasattr(os, 'link'):
  1345.                     os.link(os.path.join(self._path, str(key)), os.path.join(self._path, str(prev + 1)))
  1346.                     os.unlink(os.path.join(self._path, str(key)))
  1347.                 else:
  1348.                     os.rename(os.path.join(self._path, str(key)), os.path.join(self._path, str(prev + 1)))
  1349.             
  1350.             prev += 1
  1351.         
  1352.         self._next_key = prev + 1
  1353.         if len(changes) == 0:
  1354.             return None
  1355.         
  1356.         for name, key_list in sequences.items():
  1357.             for old, new in changes:
  1358.                 if old in key_list:
  1359.                     key_list[key_list.index(old)] = new
  1360.                     continue
  1361.             
  1362.         
  1363.         self.set_sequences(sequences)
  1364.  
  1365.     
  1366.     def _dump_sequences(self, message, key):
  1367.         '''Inspect a new MHMessage and update sequences appropriately.'''
  1368.         pending_sequences = message.get_sequences()
  1369.         all_sequences = self.get_sequences()
  1370.         for name, key_list in all_sequences.iteritems():
  1371.             if name in pending_sequences:
  1372.                 key_list.append(key)
  1373.                 continue
  1374.             if key in key_list:
  1375.                 del key_list[key_list.index(key)]
  1376.                 continue
  1377.         
  1378.         for sequence in pending_sequences:
  1379.             if sequence not in all_sequences:
  1380.                 all_sequences[sequence] = [
  1381.                     key]
  1382.                 continue
  1383.         
  1384.         self.set_sequences(all_sequences)
  1385.  
  1386.  
  1387.  
  1388. class Babyl(_singlefileMailbox):
  1389.     '''An Rmail-style Babyl mailbox.'''
  1390.     _special_labels = frozenset(('unseen', 'deleted', 'filed', 'answered', 'forwarded', 'edited', 'resent'))
  1391.     
  1392.     def __init__(self, path, factory = None, create = True):
  1393.         '''Initialize a Babyl mailbox.'''
  1394.         _singlefileMailbox.__init__(self, path, factory, create)
  1395.         self._labels = { }
  1396.  
  1397.     
  1398.     def add(self, message):
  1399.         '''Add message and return assigned key.'''
  1400.         key = _singlefileMailbox.add(self, message)
  1401.         if isinstance(message, BabylMessage):
  1402.             self._labels[key] = message.get_labels()
  1403.         
  1404.         return key
  1405.  
  1406.     
  1407.     def remove(self, key):
  1408.         """Remove the keyed message; raise KeyError if it doesn't exist."""
  1409.         _singlefileMailbox.remove(self, key)
  1410.         if key in self._labels:
  1411.             del self._labels[key]
  1412.         
  1413.  
  1414.     
  1415.     def __setitem__(self, key, message):
  1416.         """Replace the keyed message; raise KeyError if it doesn't exist."""
  1417.         _singlefileMailbox.__setitem__(self, key, message)
  1418.         if isinstance(message, BabylMessage):
  1419.             self._labels[key] = message.get_labels()
  1420.         
  1421.  
  1422.     
  1423.     def get_message(self, key):
  1424.         '''Return a Message representation or raise a KeyError.'''
  1425.         (start, stop) = self._lookup(key)
  1426.         self._file.seek(start)
  1427.         self._file.readline()
  1428.         original_headers = StringIO.StringIO()
  1429.         while True:
  1430.             line = self._file.readline()
  1431.             if line == '*** EOOH ***' + os.linesep or line == '':
  1432.                 break
  1433.             
  1434.             original_headers.write(line.replace(os.linesep, '\n'))
  1435.         visible_headers = StringIO.StringIO()
  1436.         while True:
  1437.             line = self._file.readline()
  1438.             if line == os.linesep or line == '':
  1439.                 break
  1440.             
  1441.             visible_headers.write(line.replace(os.linesep, '\n'))
  1442.         body = self._file.read(stop - self._file.tell()).replace(os.linesep, '\n')
  1443.         msg = BabylMessage(original_headers.getvalue() + body)
  1444.         msg.set_visible(visible_headers.getvalue())
  1445.         if key in self._labels:
  1446.             msg.set_labels(self._labels[key])
  1447.         
  1448.         return msg
  1449.  
  1450.     
  1451.     def get_string(self, key):
  1452.         '''Return a string representation or raise a KeyError.'''
  1453.         (start, stop) = self._lookup(key)
  1454.         self._file.seek(start)
  1455.         self._file.readline()
  1456.         original_headers = StringIO.StringIO()
  1457.         while True:
  1458.             line = self._file.readline()
  1459.             if line == '*** EOOH ***' + os.linesep or line == '':
  1460.                 break
  1461.             
  1462.             original_headers.write(line.replace(os.linesep, '\n'))
  1463.         while True:
  1464.             line = self._file.readline()
  1465.             if line == os.linesep or line == '':
  1466.                 break
  1467.                 continue
  1468.         return original_headers.getvalue() + self._file.read(stop - self._file.tell()).replace(os.linesep, '\n')
  1469.  
  1470.     
  1471.     def get_file(self, key):
  1472.         '''Return a file-like representation or raise a KeyError.'''
  1473.         return StringIO.StringIO(self.get_string(key).replace('\n', os.linesep))
  1474.  
  1475.     
  1476.     def get_labels(self):
  1477.         '''Return a list of user-defined labels in the mailbox.'''
  1478.         self._lookup()
  1479.         labels = set()
  1480.         for label_list in self._labels.values():
  1481.             labels.update(label_list)
  1482.         
  1483.         labels.difference_update(self._special_labels)
  1484.         return list(labels)
  1485.  
  1486.     
  1487.     def _generate_toc(self):
  1488.         '''Generate key-to-(start, stop) table of contents.'''
  1489.         starts = []
  1490.         stops = []
  1491.         self._file.seek(0)
  1492.         next_pos = 0
  1493.         label_lists = []
  1494.         while True:
  1495.             line_pos = next_pos
  1496.             line = self._file.readline()
  1497.             next_pos = self._file.tell()
  1498.             if line == '\x1f\x0c' + os.linesep:
  1499.                 if len(stops) < len(starts):
  1500.                     stops.append(line_pos - len(os.linesep))
  1501.                 
  1502.                 starts.append(next_pos)
  1503.                 labels = _[1]
  1504.                 label_lists.append(labels)
  1505.                 continue
  1506.             []
  1507.             if line == '\x1f' or line == '\x1f' + os.linesep:
  1508.                 if len(stops) < len(starts):
  1509.                     stops.append(line_pos - len(os.linesep))
  1510.                 
  1511.             len(stops) < len(starts)
  1512.             if line == '':
  1513.                 stops.append(line_pos - len(os.linesep))
  1514.                 break
  1515.                 continue
  1516.             []
  1517.         self._toc = dict(enumerate(zip(starts, stops)))
  1518.         self._labels = dict(enumerate(label_lists))
  1519.         self._next_key = len(self._toc)
  1520.  
  1521.     
  1522.     def _pre_mailbox_hook(self, f):
  1523.         '''Called before writing the mailbox to file f.'''
  1524.         f.write('BABYL OPTIONS:%sVersion: 5%sLabels:%s%s\x1f' % (os.linesep, os.linesep, ','.join(self.get_labels()), os.linesep))
  1525.  
  1526.     
  1527.     def _pre_message_hook(self, f):
  1528.         '''Called before writing each message to file f.'''
  1529.         f.write('\x0c' + os.linesep)
  1530.  
  1531.     
  1532.     def _post_message_hook(self, f):
  1533.         '''Called after writing each message to file f.'''
  1534.         f.write(os.linesep + '\x1f')
  1535.  
  1536.     
  1537.     def _install_message(self, message):
  1538.         '''Write message contents and return (start, stop).'''
  1539.         start = self._file.tell()
  1540.         if isinstance(message, BabylMessage):
  1541.             special_labels = []
  1542.             labels = []
  1543.             for label in message.get_labels():
  1544.                 if label in self._special_labels:
  1545.                     special_labels.append(label)
  1546.                     continue
  1547.                 labels.append(label)
  1548.             
  1549.             self._file.write('1')
  1550.             for label in special_labels:
  1551.                 self._file.write(', ' + label)
  1552.             
  1553.             self._file.write(',,')
  1554.             for label in labels:
  1555.                 self._file.write(' ' + label + ',')
  1556.             
  1557.             self._file.write(os.linesep)
  1558.         else:
  1559.             self._file.write('1,,' + os.linesep)
  1560.         if isinstance(message, email.Message.Message):
  1561.             orig_buffer = StringIO.StringIO()
  1562.             orig_generator = email.Generator.Generator(orig_buffer, False, 0)
  1563.             orig_generator.flatten(message)
  1564.             orig_buffer.seek(0)
  1565.             while True:
  1566.                 line = orig_buffer.readline()
  1567.                 self._file.write(line.replace('\n', os.linesep))
  1568.                 if line == '\n' or line == '':
  1569.                     break
  1570.                     continue
  1571.             self._file.write('*** EOOH ***' + os.linesep)
  1572.             if isinstance(message, BabylMessage):
  1573.                 vis_buffer = StringIO.StringIO()
  1574.                 vis_generator = email.Generator.Generator(vis_buffer, False, 0)
  1575.                 vis_generator.flatten(message.get_visible())
  1576.                 while True:
  1577.                     line = vis_buffer.readline()
  1578.                     self._file.write(line.replace('\n', os.linesep))
  1579.                     if line == '\n' or line == '':
  1580.                         break
  1581.                         continue
  1582.             else:
  1583.                 orig_buffer.seek(0)
  1584.                 while True:
  1585.                     line = orig_buffer.readline()
  1586.                     self._file.write(line.replace('\n', os.linesep))
  1587.                     if line == '\n' or line == '':
  1588.                         break
  1589.                         continue
  1590.             while True:
  1591.                 buffer = orig_buffer.read(4096)
  1592.                 if buffer == '':
  1593.                     break
  1594.                 
  1595.                 self._file.write(buffer.replace('\n', os.linesep))
  1596.         elif isinstance(message, str):
  1597.             body_start = message.find('\n\n') + 2
  1598.             if body_start - 2 != -1:
  1599.                 self._file.write(message[:body_start].replace('\n', os.linesep))
  1600.                 self._file.write('*** EOOH ***' + os.linesep)
  1601.                 self._file.write(message[:body_start].replace('\n', os.linesep))
  1602.                 self._file.write(message[body_start:].replace('\n', os.linesep))
  1603.             else:
  1604.                 self._file.write('*** EOOH ***' + os.linesep + os.linesep)
  1605.                 self._file.write(message.replace('\n', os.linesep))
  1606.         elif hasattr(message, 'readline'):
  1607.             original_pos = message.tell()
  1608.             first_pass = True
  1609.             while True:
  1610.                 line = message.readline()
  1611.                 self._file.write(line.replace('\n', os.linesep))
  1612.                 if line == '\n' or line == '':
  1613.                     self._file.write('*** EOOH ***' + os.linesep)
  1614.                     if first_pass:
  1615.                         first_pass = False
  1616.                         message.seek(original_pos)
  1617.                     else:
  1618.                         break
  1619.                 first_pass
  1620.             while True:
  1621.                 buffer = message.read(4096)
  1622.                 if buffer == '':
  1623.                     break
  1624.                 
  1625.                 self._file.write(buffer.replace('\n', os.linesep))
  1626.         else:
  1627.             raise TypeError('Invalid message type: %s' % type(message))
  1628.         stop = self._file.tell()
  1629.         return (start, stop)
  1630.  
  1631.  
  1632.  
  1633. class Message(email.Message.Message):
  1634.     '''Message with mailbox-format-specific properties.'''
  1635.     
  1636.     def __init__(self, message = None):
  1637.         '''Initialize a Message instance.'''
  1638.         if isinstance(message, email.Message.Message):
  1639.             self._become_message(copy.deepcopy(message))
  1640.             if isinstance(message, Message):
  1641.                 message._explain_to(self)
  1642.             
  1643.         elif isinstance(message, str):
  1644.             self._become_message(email.message_from_string(message))
  1645.         elif hasattr(message, 'read'):
  1646.             self._become_message(email.message_from_file(message))
  1647.         elif message is None:
  1648.             email.Message.Message.__init__(self)
  1649.         else:
  1650.             raise TypeError('Invalid message type: %s' % type(message))
  1651.  
  1652.     
  1653.     def _become_message(self, message):
  1654.         '''Assume the non-format-specific state of message.'''
  1655.         for name in ('_headers', '_unixfrom', '_payload', '_charset', 'preamble', 'epilogue', 'defects', '_default_type'):
  1656.             self.__dict__[name] = message.__dict__[name]
  1657.         
  1658.  
  1659.     
  1660.     def _explain_to(self, message):
  1661.         '''Copy format-specific state to message insofar as possible.'''
  1662.         if isinstance(message, Message):
  1663.             return None
  1664.         else:
  1665.             raise TypeError('Cannot convert to specified type')
  1666.  
  1667.  
  1668.  
  1669. class MaildirMessage(Message):
  1670.     '''Message with Maildir-specific properties.'''
  1671.     
  1672.     def __init__(self, message = None):
  1673.         '''Initialize a MaildirMessage instance.'''
  1674.         self._subdir = 'new'
  1675.         self._info = ''
  1676.         self._date = time.time()
  1677.         Message.__init__(self, message)
  1678.  
  1679.     
  1680.     def get_subdir(self):
  1681.         """Return 'new' or 'cur'."""
  1682.         return self._subdir
  1683.  
  1684.     
  1685.     def set_subdir(self, subdir):
  1686.         """Set subdir to 'new' or 'cur'."""
  1687.         if subdir == 'new' or subdir == 'cur':
  1688.             self._subdir = subdir
  1689.         else:
  1690.             raise ValueError("subdir must be 'new' or 'cur': %s" % subdir)
  1691.  
  1692.     
  1693.     def get_flags(self):
  1694.         '''Return as a string the flags that are set.'''
  1695.         if self._info.startswith('2,'):
  1696.             return self._info[2:]
  1697.         else:
  1698.             return ''
  1699.  
  1700.     
  1701.     def set_flags(self, flags):
  1702.         '''Set the given flags and unset all others.'''
  1703.         self._info = '2,' + ''.join(sorted(flags))
  1704.  
  1705.     
  1706.     def add_flag(self, flag):
  1707.         '''Set the given flag(s) without changing others.'''
  1708.         self.set_flags(''.join(set(self.get_flags()) | set(flag)))
  1709.  
  1710.     
  1711.     def remove_flag(self, flag):
  1712.         '''Unset the given string flag(s) without changing others.'''
  1713.         if self.get_flags() != '':
  1714.             self.set_flags(''.join(set(self.get_flags()) - set(flag)))
  1715.         
  1716.  
  1717.     
  1718.     def get_date(self):
  1719.         '''Return delivery date of message, in seconds since the epoch.'''
  1720.         return self._date
  1721.  
  1722.     
  1723.     def set_date(self, date):
  1724.         '''Set delivery date of message, in seconds since the epoch.'''
  1725.         
  1726.         try:
  1727.             self._date = float(date)
  1728.         except ValueError:
  1729.             raise TypeError("can't convert to float: %s" % date)
  1730.  
  1731.  
  1732.     
  1733.     def get_info(self):
  1734.         '''Get the message\'s "info" as a string.'''
  1735.         return self._info
  1736.  
  1737.     
  1738.     def set_info(self, info):
  1739.         '''Set the message\'s "info" string.'''
  1740.         if isinstance(info, str):
  1741.             self._info = info
  1742.         else:
  1743.             raise TypeError('info must be a string: %s' % type(info))
  1744.  
  1745.     
  1746.     def _explain_to(self, message):
  1747.         '''Copy Maildir-specific state to message insofar as possible.'''
  1748.         if isinstance(message, MaildirMessage):
  1749.             message.set_flags(self.get_flags())
  1750.             message.set_subdir(self.get_subdir())
  1751.             message.set_date(self.get_date())
  1752.         elif isinstance(message, _mboxMMDFMessage):
  1753.             flags = set(self.get_flags())
  1754.             if 'S' in flags:
  1755.                 message.add_flag('R')
  1756.             
  1757.             if self.get_subdir() == 'cur':
  1758.                 message.add_flag('O')
  1759.             
  1760.             if 'T' in flags:
  1761.                 message.add_flag('D')
  1762.             
  1763.             if 'F' in flags:
  1764.                 message.add_flag('F')
  1765.             
  1766.             if 'R' in flags:
  1767.                 message.add_flag('A')
  1768.             
  1769.             message.set_from('MAILER-DAEMON', time.gmtime(self.get_date()))
  1770.         elif isinstance(message, MHMessage):
  1771.             flags = set(self.get_flags())
  1772.             if 'S' not in flags:
  1773.                 message.add_sequence('unseen')
  1774.             
  1775.             if 'R' in flags:
  1776.                 message.add_sequence('replied')
  1777.             
  1778.             if 'F' in flags:
  1779.                 message.add_sequence('flagged')
  1780.             
  1781.         elif isinstance(message, BabylMessage):
  1782.             flags = set(self.get_flags())
  1783.             if 'S' not in flags:
  1784.                 message.add_label('unseen')
  1785.             
  1786.             if 'T' in flags:
  1787.                 message.add_label('deleted')
  1788.             
  1789.             if 'R' in flags:
  1790.                 message.add_label('answered')
  1791.             
  1792.             if 'P' in flags:
  1793.                 message.add_label('forwarded')
  1794.             
  1795.         elif isinstance(message, Message):
  1796.             pass
  1797.         else:
  1798.             raise TypeError('Cannot convert to specified type: %s' % type(message))
  1799.  
  1800.  
  1801.  
  1802. class _mboxMMDFMessage(Message):
  1803.     '''Message with mbox- or MMDF-specific properties.'''
  1804.     
  1805.     def __init__(self, message = None):
  1806.         '''Initialize an mboxMMDFMessage instance.'''
  1807.         self.set_from('MAILER-DAEMON', True)
  1808.         if isinstance(message, email.Message.Message):
  1809.             unixfrom = message.get_unixfrom()
  1810.             if unixfrom is not None and unixfrom.startswith('From '):
  1811.                 self.set_from(unixfrom[5:])
  1812.             
  1813.         
  1814.         Message.__init__(self, message)
  1815.  
  1816.     
  1817.     def get_from(self):
  1818.         '''Return contents of "From " line.'''
  1819.         return self._from
  1820.  
  1821.     
  1822.     def set_from(self, from_, time_ = None):
  1823.         '''Set "From " line, formatting and appending time_ if specified.'''
  1824.         if time_ is not None:
  1825.             if time_ is True:
  1826.                 time_ = time.gmtime()
  1827.             
  1828.             from_ += ' ' + time.asctime(time_)
  1829.         
  1830.         self._from = from_
  1831.  
  1832.     
  1833.     def get_flags(self):
  1834.         '''Return as a string the flags that are set.'''
  1835.         return self.get('Status', '') + self.get('X-Status', '')
  1836.  
  1837.     
  1838.     def set_flags(self, flags):
  1839.         '''Set the given flags and unset all others.'''
  1840.         flags = set(flags)
  1841.         (status_flags, xstatus_flags) = ('', '')
  1842.         for flag in ('R', 'O'):
  1843.             if flag in flags:
  1844.                 status_flags += flag
  1845.                 flags.remove(flag)
  1846.                 continue
  1847.         
  1848.         for flag in ('D', 'F', 'A'):
  1849.             if flag in flags:
  1850.                 xstatus_flags += flag
  1851.                 flags.remove(flag)
  1852.                 continue
  1853.         
  1854.         xstatus_flags += ''.join(sorted(flags))
  1855.         
  1856.         try:
  1857.             self.replace_header('Status', status_flags)
  1858.         except KeyError:
  1859.             self.add_header('Status', status_flags)
  1860.  
  1861.         
  1862.         try:
  1863.             self.replace_header('X-Status', xstatus_flags)
  1864.         except KeyError:
  1865.             self.add_header('X-Status', xstatus_flags)
  1866.  
  1867.  
  1868.     
  1869.     def add_flag(self, flag):
  1870.         '''Set the given flag(s) without changing others.'''
  1871.         self.set_flags(''.join(set(self.get_flags()) | set(flag)))
  1872.  
  1873.     
  1874.     def remove_flag(self, flag):
  1875.         '''Unset the given string flag(s) without changing others.'''
  1876.         if 'Status' in self or 'X-Status' in self:
  1877.             self.set_flags(''.join(set(self.get_flags()) - set(flag)))
  1878.         
  1879.  
  1880.     
  1881.     def _explain_to(self, message):
  1882.         '''Copy mbox- or MMDF-specific state to message insofar as possible.'''
  1883.         if isinstance(message, MaildirMessage):
  1884.             flags = set(self.get_flags())
  1885.             if 'O' in flags:
  1886.                 message.set_subdir('cur')
  1887.             
  1888.             if 'F' in flags:
  1889.                 message.add_flag('F')
  1890.             
  1891.             if 'A' in flags:
  1892.                 message.add_flag('R')
  1893.             
  1894.             if 'R' in flags:
  1895.                 message.add_flag('S')
  1896.             
  1897.             if 'D' in flags:
  1898.                 message.add_flag('T')
  1899.             
  1900.             del message['status']
  1901.             del message['x-status']
  1902.             maybe_date = ' '.join(self.get_from().split()[-5:])
  1903.             
  1904.             try:
  1905.                 message.set_date(calendar.timegm(time.strptime(maybe_date, '%a %b %d %H:%M:%S %Y')))
  1906.             except (ValueError, OverflowError):
  1907.                 pass
  1908.             except:
  1909.                 None<EXCEPTION MATCH>(ValueError, OverflowError)
  1910.             
  1911.  
  1912.         None<EXCEPTION MATCH>(ValueError, OverflowError)
  1913.         if isinstance(message, _mboxMMDFMessage):
  1914.             message.set_flags(self.get_flags())
  1915.             message.set_from(self.get_from())
  1916.         elif isinstance(message, MHMessage):
  1917.             flags = set(self.get_flags())
  1918.             if 'R' not in flags:
  1919.                 message.add_sequence('unseen')
  1920.             
  1921.             if 'A' in flags:
  1922.                 message.add_sequence('replied')
  1923.             
  1924.             if 'F' in flags:
  1925.                 message.add_sequence('flagged')
  1926.             
  1927.             del message['status']
  1928.             del message['x-status']
  1929.         elif isinstance(message, BabylMessage):
  1930.             flags = set(self.get_flags())
  1931.             if 'R' not in flags:
  1932.                 message.add_label('unseen')
  1933.             
  1934.             if 'D' in flags:
  1935.                 message.add_label('deleted')
  1936.             
  1937.             if 'A' in flags:
  1938.                 message.add_label('answered')
  1939.             
  1940.             del message['status']
  1941.             del message['x-status']
  1942.         elif isinstance(message, Message):
  1943.             pass
  1944.         else:
  1945.             raise TypeError('Cannot convert to specified type: %s' % type(message))
  1946.  
  1947.  
  1948.  
  1949. class mboxMessage(_mboxMMDFMessage):
  1950.     '''Message with mbox-specific properties.'''
  1951.     pass
  1952.  
  1953.  
  1954. class MHMessage(Message):
  1955.     '''Message with MH-specific properties.'''
  1956.     
  1957.     def __init__(self, message = None):
  1958.         '''Initialize an MHMessage instance.'''
  1959.         self._sequences = []
  1960.         Message.__init__(self, message)
  1961.  
  1962.     
  1963.     def get_sequences(self):
  1964.         '''Return a list of sequences that include the message.'''
  1965.         return self._sequences[:]
  1966.  
  1967.     
  1968.     def set_sequences(self, sequences):
  1969.         '''Set the list of sequences that include the message.'''
  1970.         self._sequences = list(sequences)
  1971.  
  1972.     
  1973.     def add_sequence(self, sequence):
  1974.         '''Add sequence to list of sequences including the message.'''
  1975.         if isinstance(sequence, str):
  1976.             if sequence not in self._sequences:
  1977.                 self._sequences.append(sequence)
  1978.             
  1979.         else:
  1980.             raise TypeError('sequence must be a string: %s' % type(sequence))
  1981.  
  1982.     
  1983.     def remove_sequence(self, sequence):
  1984.         '''Remove sequence from the list of sequences including the message.'''
  1985.         
  1986.         try:
  1987.             self._sequences.remove(sequence)
  1988.         except ValueError:
  1989.             pass
  1990.  
  1991.  
  1992.     
  1993.     def _explain_to(self, message):
  1994.         '''Copy MH-specific state to message insofar as possible.'''
  1995.         if isinstance(message, MaildirMessage):
  1996.             sequences = set(self.get_sequences())
  1997.             if 'unseen' in sequences:
  1998.                 message.set_subdir('cur')
  1999.             else:
  2000.                 message.set_subdir('cur')
  2001.                 message.add_flag('S')
  2002.             if 'flagged' in sequences:
  2003.                 message.add_flag('F')
  2004.             
  2005.             if 'replied' in sequences:
  2006.                 message.add_flag('R')
  2007.             
  2008.         elif isinstance(message, _mboxMMDFMessage):
  2009.             sequences = set(self.get_sequences())
  2010.             if 'unseen' not in sequences:
  2011.                 message.add_flag('RO')
  2012.             else:
  2013.                 message.add_flag('O')
  2014.             if 'flagged' in sequences:
  2015.                 message.add_flag('F')
  2016.             
  2017.             if 'replied' in sequences:
  2018.                 message.add_flag('A')
  2019.             
  2020.         elif isinstance(message, MHMessage):
  2021.             for sequence in self.get_sequences():
  2022.                 message.add_sequence(sequence)
  2023.             
  2024.         elif isinstance(message, BabylMessage):
  2025.             sequences = set(self.get_sequences())
  2026.             if 'unseen' in sequences:
  2027.                 message.add_label('unseen')
  2028.             
  2029.             if 'replied' in sequences:
  2030.                 message.add_label('answered')
  2031.             
  2032.         elif isinstance(message, Message):
  2033.             pass
  2034.         else:
  2035.             raise TypeError('Cannot convert to specified type: %s' % type(message))
  2036.  
  2037.  
  2038.  
  2039. class BabylMessage(Message):
  2040.     '''Message with Babyl-specific properties.'''
  2041.     
  2042.     def __init__(self, message = None):
  2043.         '''Initialize an BabylMessage instance.'''
  2044.         self._labels = []
  2045.         self._visible = Message()
  2046.         Message.__init__(self, message)
  2047.  
  2048.     
  2049.     def get_labels(self):
  2050.         '''Return a list of labels on the message.'''
  2051.         return self._labels[:]
  2052.  
  2053.     
  2054.     def set_labels(self, labels):
  2055.         '''Set the list of labels on the message.'''
  2056.         self._labels = list(labels)
  2057.  
  2058.     
  2059.     def add_label(self, label):
  2060.         '''Add label to list of labels on the message.'''
  2061.         if isinstance(label, str):
  2062.             if label not in self._labels:
  2063.                 self._labels.append(label)
  2064.             
  2065.         else:
  2066.             raise TypeError('label must be a string: %s' % type(label))
  2067.  
  2068.     
  2069.     def remove_label(self, label):
  2070.         '''Remove label from the list of labels on the message.'''
  2071.         
  2072.         try:
  2073.             self._labels.remove(label)
  2074.         except ValueError:
  2075.             pass
  2076.  
  2077.  
  2078.     
  2079.     def get_visible(self):
  2080.         '''Return a Message representation of visible headers.'''
  2081.         return Message(self._visible)
  2082.  
  2083.     
  2084.     def set_visible(self, visible):
  2085.         '''Set the Message representation of visible headers.'''
  2086.         self._visible = Message(visible)
  2087.  
  2088.     
  2089.     def update_visible(self):
  2090.         '''Update and/or sensibly generate a set of visible headers.'''
  2091.         for header in self._visible.keys():
  2092.             if header in self:
  2093.                 self._visible.replace_header(header, self[header])
  2094.                 continue
  2095.             del self._visible[header]
  2096.         
  2097.         for header in ('Date', 'From', 'Reply-To', 'To', 'CC', 'Subject'):
  2098.             if header in self and header not in self._visible:
  2099.                 self._visible[header] = self[header]
  2100.                 continue
  2101.         
  2102.  
  2103.     
  2104.     def _explain_to(self, message):
  2105.         '''Copy Babyl-specific state to message insofar as possible.'''
  2106.         if isinstance(message, MaildirMessage):
  2107.             labels = set(self.get_labels())
  2108.             if 'unseen' in labels:
  2109.                 message.set_subdir('cur')
  2110.             else:
  2111.                 message.set_subdir('cur')
  2112.                 message.add_flag('S')
  2113.             if 'forwarded' in labels or 'resent' in labels:
  2114.                 message.add_flag('P')
  2115.             
  2116.             if 'answered' in labels:
  2117.                 message.add_flag('R')
  2118.             
  2119.             if 'deleted' in labels:
  2120.                 message.add_flag('T')
  2121.             
  2122.         elif isinstance(message, _mboxMMDFMessage):
  2123.             labels = set(self.get_labels())
  2124.             if 'unseen' not in labels:
  2125.                 message.add_flag('RO')
  2126.             else:
  2127.                 message.add_flag('O')
  2128.             if 'deleted' in labels:
  2129.                 message.add_flag('D')
  2130.             
  2131.             if 'answered' in labels:
  2132.                 message.add_flag('A')
  2133.             
  2134.         elif isinstance(message, MHMessage):
  2135.             labels = set(self.get_labels())
  2136.             if 'unseen' in labels:
  2137.                 message.add_sequence('unseen')
  2138.             
  2139.             if 'answered' in labels:
  2140.                 message.add_sequence('replied')
  2141.             
  2142.         elif isinstance(message, BabylMessage):
  2143.             message.set_visible(self.get_visible())
  2144.             for label in self.get_labels():
  2145.                 message.add_label(label)
  2146.             
  2147.         elif isinstance(message, Message):
  2148.             pass
  2149.         else:
  2150.             raise TypeError('Cannot convert to specified type: %s' % type(message))
  2151.  
  2152.  
  2153.  
  2154. class MMDFMessage(_mboxMMDFMessage):
  2155.     '''Message with MMDF-specific properties.'''
  2156.     pass
  2157.  
  2158.  
  2159. class _ProxyFile:
  2160.     '''A read-only wrapper of a file.'''
  2161.     
  2162.     def __init__(self, f, pos = None):
  2163.         '''Initialize a _ProxyFile.'''
  2164.         self._file = f
  2165.         if pos is None:
  2166.             self._pos = f.tell()
  2167.         else:
  2168.             self._pos = pos
  2169.  
  2170.     
  2171.     def read(self, size = None):
  2172.         '''Read bytes.'''
  2173.         return self._read(size, self._file.read)
  2174.  
  2175.     
  2176.     def readline(self, size = None):
  2177.         '''Read a line.'''
  2178.         return self._read(size, self._file.readline)
  2179.  
  2180.     
  2181.     def readlines(self, sizehint = None):
  2182.         '''Read multiple lines.'''
  2183.         result = []
  2184.         for line in self:
  2185.             result.append(line)
  2186.             if sizehint is not None:
  2187.                 sizehint -= len(line)
  2188.                 if sizehint <= 0:
  2189.                     break
  2190.                 
  2191.             sizehint <= 0
  2192.         
  2193.         return result
  2194.  
  2195.     
  2196.     def __iter__(self):
  2197.         '''Iterate over lines.'''
  2198.         return iter(self.readline, '')
  2199.  
  2200.     
  2201.     def tell(self):
  2202.         '''Return the position.'''
  2203.         return self._pos
  2204.  
  2205.     
  2206.     def seek(self, offset, whence = 0):
  2207.         '''Change position.'''
  2208.         if whence == 1:
  2209.             self._file.seek(self._pos)
  2210.         
  2211.         self._file.seek(offset, whence)
  2212.         self._pos = self._file.tell()
  2213.  
  2214.     
  2215.     def close(self):
  2216.         '''Close the file.'''
  2217.         del self._file
  2218.  
  2219.     
  2220.     def _read(self, size, read_method):
  2221.         '''Read size bytes using read_method.'''
  2222.         if size is None:
  2223.             size = -1
  2224.         
  2225.         self._file.seek(self._pos)
  2226.         result = read_method(size)
  2227.         self._pos = self._file.tell()
  2228.         return result
  2229.  
  2230.  
  2231.  
  2232. class _PartialFile(_ProxyFile):
  2233.     '''A read-only wrapper of part of a file.'''
  2234.     
  2235.     def __init__(self, f, start = None, stop = None):
  2236.         '''Initialize a _PartialFile.'''
  2237.         _ProxyFile.__init__(self, f, start)
  2238.         self._start = start
  2239.         self._stop = stop
  2240.  
  2241.     
  2242.     def tell(self):
  2243.         '''Return the position with respect to start.'''
  2244.         return _ProxyFile.tell(self) - self._start
  2245.  
  2246.     
  2247.     def seek(self, offset, whence = 0):
  2248.         '''Change position, possibly with respect to start or stop.'''
  2249.         if whence == 0:
  2250.             self._pos = self._start
  2251.             whence = 1
  2252.         elif whence == 2:
  2253.             self._pos = self._stop
  2254.             whence = 1
  2255.         
  2256.         _ProxyFile.seek(self, offset, whence)
  2257.  
  2258.     
  2259.     def _read(self, size, read_method):
  2260.         '''Read size bytes using read_method, honoring start and stop.'''
  2261.         remaining = self._stop - self._pos
  2262.         if remaining <= 0:
  2263.             return ''
  2264.         
  2265.         if size is None and size < 0 or size > remaining:
  2266.             size = remaining
  2267.         
  2268.         return _ProxyFile._read(self, size, read_method)
  2269.  
  2270.  
  2271.  
  2272. def _lock_file(f, dotlock = True):
  2273.     '''Lock file f using lockf and dot locking.'''
  2274.     dotlock_done = False
  2275.     
  2276.     try:
  2277.         if fcntl:
  2278.             
  2279.             try:
  2280.                 fcntl.lockf(f, fcntl.LOCK_EX | fcntl.LOCK_NB)
  2281.             except IOError:
  2282.                 e = None
  2283.                 if e.errno in (errno.EAGAIN, errno.EACCES):
  2284.                     raise ExternalClashError('lockf: lock unavailable: %s' % f.name)
  2285.                 else:
  2286.                     raise 
  2287.             except:
  2288.                 e.errno in (errno.EAGAIN, errno.EACCES)
  2289.             
  2290.  
  2291.         None<EXCEPTION MATCH>IOError
  2292.         if dotlock:
  2293.             
  2294.             try:
  2295.                 pre_lock = _create_temporary(f.name + '.lock')
  2296.                 pre_lock.close()
  2297.             except IOError:
  2298.                 e = None
  2299.                 if e.errno == errno.EACCES:
  2300.                     return None
  2301.                 else:
  2302.                     raise 
  2303.             except:
  2304.                 e.errno == errno.EACCES
  2305.  
  2306.             
  2307.             try:
  2308.                 if hasattr(os, 'link'):
  2309.                     os.link(pre_lock.name, f.name + '.lock')
  2310.                     dotlock_done = True
  2311.                     os.unlink(pre_lock.name)
  2312.                 else:
  2313.                     os.rename(pre_lock.name, f.name + '.lock')
  2314.                     dotlock_done = True
  2315.             except OSError:
  2316.                 e = None
  2317.                 if (e.errno == errno.EEXIST or os.name == 'os2') and e.errno == errno.EACCES:
  2318.                     os.remove(pre_lock.name)
  2319.                     raise ExternalClashError('dot lock unavailable: %s' % f.name)
  2320.                 else:
  2321.                     raise 
  2322.             except:
  2323.                 e.errno == errno.EACCES
  2324.             
  2325.  
  2326.         None<EXCEPTION MATCH>OSError
  2327.     except:
  2328.         if fcntl:
  2329.             fcntl.lockf(f, fcntl.LOCK_UN)
  2330.         
  2331.         if dotlock_done:
  2332.             os.remove(f.name + '.lock')
  2333.         
  2334.         raise 
  2335.  
  2336.  
  2337.  
  2338. def _unlock_file(f):
  2339.     '''Unlock file f using lockf and dot locking.'''
  2340.     if fcntl:
  2341.         fcntl.lockf(f, fcntl.LOCK_UN)
  2342.     
  2343.     if os.path.exists(f.name + '.lock'):
  2344.         os.remove(f.name + '.lock')
  2345.     
  2346.  
  2347.  
  2348. def _create_carefully(path):
  2349.     """Create a file if it doesn't exist and open for reading and writing."""
  2350.     fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDWR)
  2351.     
  2352.     try:
  2353.         return open(path, 'rb+')
  2354.     finally:
  2355.         os.close(fd)
  2356.  
  2357.  
  2358.  
  2359. def _create_temporary(path):
  2360.     '''Create a temp file based on path and open for reading and writing.'''
  2361.     return _create_carefully('%s.%s.%s.%s' % (path, int(time.time()), socket.gethostname(), os.getpid()))
  2362.  
  2363.  
  2364. def _sync_flush(f):
  2365.     '''Ensure changes to file f are physically on disk.'''
  2366.     f.flush()
  2367.     if hasattr(os, 'fsync'):
  2368.         os.fsync(f.fileno())
  2369.     
  2370.  
  2371.  
  2372. def _sync_close(f):
  2373.     '''Close file f, ensuring all changes are physically on disk.'''
  2374.     _sync_flush(f)
  2375.     f.close()
  2376.  
  2377.  
  2378. class _Mailbox:
  2379.     
  2380.     def __init__(self, fp, factory = rfc822.Message):
  2381.         self.fp = fp
  2382.         self.seekp = 0
  2383.         self.factory = factory
  2384.  
  2385.     
  2386.     def __iter__(self):
  2387.         return iter(self.next, None)
  2388.  
  2389.     
  2390.     def next(self):
  2391.         while None:
  2392.             
  2393.             try:
  2394.                 self._search_start()
  2395.             except EOFError:
  2396.                 self.seekp = self.fp.tell()
  2397.                 return None
  2398.  
  2399.             start = self.fp.tell()
  2400.             self._search_end()
  2401.             self.seekp = stop = self.fp.tell()
  2402.             if start != stop:
  2403.                 break
  2404.                 continue
  2405.             continue
  2406.             return self.factory(_PartialFile(self.fp, start, stop))
  2407.  
  2408.  
  2409.  
  2410. class UnixMailbox(_Mailbox):
  2411.     
  2412.     def _search_start(self):
  2413.         while None:
  2414.             pos = self.fp.tell()
  2415.             line = self.fp.readline()
  2416.             if not line:
  2417.                 raise EOFError
  2418.             
  2419.             if line[:5] == 'From ' and self._isrealfromline(line):
  2420.                 self.fp.seek(pos)
  2421.                 return None
  2422.                 continue
  2423.             continue
  2424.             return None
  2425.  
  2426.     
  2427.     def _search_end(self):
  2428.         self.fp.readline()
  2429.         while None:
  2430.             pos = self.fp.tell()
  2431.             line = self.fp.readline()
  2432.             if not line:
  2433.                 return None
  2434.             
  2435.             if line[:5] == 'From ' and self._isrealfromline(line):
  2436.                 self.fp.seek(pos)
  2437.                 return None
  2438.                 continue
  2439.             continue
  2440.             return None
  2441.  
  2442.     _fromlinepattern = 'From \\s*[^\\s]+\\s+\\w\\w\\w\\s+\\w\\w\\w\\s+\\d?\\d\\s+\\d?\\d:\\d\\d(:\\d\\d)?(\\s+[^\\s]+)?\\s+\\d\\d\\d\\d\\s*[^\\s]*\\s*$'
  2443.     _regexp = None
  2444.     
  2445.     def _strict_isrealfromline(self, line):
  2446.         if not self._regexp:
  2447.             import re
  2448.             self._regexp = re.compile(self._fromlinepattern)
  2449.         
  2450.         return self._regexp.match(line)
  2451.  
  2452.     
  2453.     def _portable_isrealfromline(self, line):
  2454.         return True
  2455.  
  2456.     _isrealfromline = _strict_isrealfromline
  2457.  
  2458.  
  2459. class PortableUnixMailbox(UnixMailbox):
  2460.     _isrealfromline = UnixMailbox._portable_isrealfromline
  2461.  
  2462.  
  2463. class MmdfMailbox(_Mailbox):
  2464.     
  2465.     def _search_start(self):
  2466.         while None:
  2467.             line = self.fp.readline()
  2468.             if not line:
  2469.                 raise EOFError
  2470.             
  2471.             if line[:5] == '\x01\x01\x01\x01\n':
  2472.                 return None
  2473.                 continue
  2474.             continue
  2475.             return None
  2476.  
  2477.     
  2478.     def _search_end(self):
  2479.         while None:
  2480.             pos = self.fp.tell()
  2481.             line = self.fp.readline()
  2482.             if not line:
  2483.                 return None
  2484.             
  2485.             if line == '\x01\x01\x01\x01\n':
  2486.                 self.fp.seek(pos)
  2487.                 return None
  2488.                 continue
  2489.             continue
  2490.             return None
  2491.  
  2492.  
  2493.  
  2494. class MHMailbox:
  2495.     
  2496.     def __init__(self, dirname, factory = rfc822.Message):
  2497.         import re
  2498.         pat = re.compile('^[1-9][0-9]*$')
  2499.         self.dirname = dirname
  2500.         list = os.listdir(self.dirname)
  2501.         list = filter(pat.match, list)
  2502.         list = map(long, list)
  2503.         list.sort()
  2504.         self.boxes = map(str, list)
  2505.         self.boxes.reverse()
  2506.         self.factory = factory
  2507.  
  2508.     
  2509.     def __iter__(self):
  2510.         return iter(self.next, None)
  2511.  
  2512.     
  2513.     def next(self):
  2514.         if not self.boxes:
  2515.             return None
  2516.         
  2517.         fn = self.boxes.pop()
  2518.         fp = open(os.path.join(self.dirname, fn))
  2519.         msg = self.factory(fp)
  2520.         
  2521.         try:
  2522.             msg._mh_msgno = fn
  2523.         except (AttributeError, TypeError):
  2524.             pass
  2525.  
  2526.         return msg
  2527.  
  2528.  
  2529.  
  2530. class BabylMailbox(_Mailbox):
  2531.     
  2532.     def _search_start(self):
  2533.         while None:
  2534.             line = self.fp.readline()
  2535.             if not line:
  2536.                 raise EOFError
  2537.             
  2538.             if line == '*** EOOH ***\n':
  2539.                 return None
  2540.                 continue
  2541.             continue
  2542.             return None
  2543.  
  2544.     
  2545.     def _search_end(self):
  2546.         while None:
  2547.             pos = self.fp.tell()
  2548.             line = self.fp.readline()
  2549.             if not line:
  2550.                 return None
  2551.             
  2552.             if line == '\x1f\x0c\n' or line == '\x1f':
  2553.                 self.fp.seek(pos)
  2554.                 return None
  2555.                 continue
  2556.             continue
  2557.             return None
  2558.  
  2559.  
  2560.  
  2561. class Error(Exception):
  2562.     '''Raised for module-specific errors.'''
  2563.     pass
  2564.  
  2565.  
  2566. class NoSuchMailboxError(Error):
  2567.     """The specified mailbox does not exist and won't be created."""
  2568.     pass
  2569.  
  2570.  
  2571. class NotEmptyError(Error):
  2572.     '''The specified mailbox is not empty and deletion was requested.'''
  2573.     pass
  2574.  
  2575.  
  2576. class ExternalClashError(Error):
  2577.     '''Another process caused an action to fail.'''
  2578.     pass
  2579.  
  2580.  
  2581. class FormatError(Error):
  2582.     '''A file appears to have an invalid format.'''
  2583.     pass
  2584.  
  2585.